Skip to content

Add notes that doc lookup requires REPL #52065

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 20, 2025

Conversation

sostock
Copy link
Contributor

@sostock sostock commented Nov 7, 2023

Documentation lookup with @doc, apropos, and Base.Docs.doc is exported by Base, but the actual implementation lives in the REPL. Since the REPL is no longer included in the sysimg, these functions only work if the REPL stdlib is loaded explicitly. This PR adds compat admonitions in several places.

@sostock sostock added the docs This change adds or pertains to documentation label Nov 7, 2023
@KristofferC
Copy link
Member

This feels kind of unfortunate to me. These don't really feel "REPL"y and you might want to use these programatically in many contexts that don't require a REPL, or?

@LilithHafner
Copy link
Member

CC @vchuravy

Maybe we need the Random/LinearAlgebra hack here too? Performance doesn't matter so much.

If folks want to excise the repl and still lookup documentation then maybe it makes sense to make a new "Docsystem" stdlib, but I think that is low priority.

@fingolfin
Copy link
Member

While this dependency on REPL may be "unfortunate", it is the current reality, and it seems to me we really should be documenting it?

Since the REPL stdlib is no longer included in the sysimg, doc lookup
with `@doc`, `apropos`, and `Base.Docs.doc` only works if the REPL
stdlib is loaded. Therefore, compat admonitions are added in several
places.
@fingolfin fingolfin force-pushed the doc_lookup_needs_repl branch from 9c66522 to 1b5f049 Compare May 19, 2025 21:10
@fingolfin
Copy link
Member

Updated to resolve the conflicts.

@fingolfin fingolfin added the merge me PR is reviewed. Merge when all tests are passing label May 19, 2025
@LilithHafner LilithHafner merged commit bb28ea8 into JuliaLang:master May 20, 2025
6 of 8 checks passed
@LilithHafner LilithHafner removed the merge me PR is reviewed. Merge when all tests are passing label May 20, 2025
@LilithHafner
Copy link
Member

Merging this does not preclude enabling usage of these functions without REPL and does not indicate that we don't want that solution. Just documenting reality now.

@lgoettgens
Copy link
Contributor

Merging this does not preclude enabling usage of these functions without REPL and does not indicate that we don't want that solution. Just documenting reality now.

Indeed, we still have issues like #54664 about this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants